home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 April: Mac OS SDK / Dev.CD Apr 96 SDK / Dev.CD Apr 96 SDK1.toast / Development Kits (Disc 1) / OpenDoc / Documentation / Tech Notes & Articles / Recipes / Edit Menu / Info... recipes next >
Encoding:
Text File  |  1995-04-22  |  6.0 KB  |  268 lines  |  [TEXT/ttxt]
  1. OpenDoc™ Recipes
  2.  
  3.  
  4. Info… recipes
  5. By The OpenDoc Design Team
  6. January 1995
  7.  
  8.  
  9. © 1993-1995  Apple Computer, Inc. All Rights Reserved.
  10. Apple, the Apple logo, and Macintosh are registered trademarks of Apple Computer, Inc.
  11. Mac and OpenDoc are trademarks of Apple Computer, Inc. 
  12.  
  13.  
  14.  
  15. Introduction
  16.  
  17. One of the items in the OpenDoc “Edit” menu is “… Info…” which a user chooses if they want to get information about the selection like its name, kind, category, mod/creation dates, comments, etc.  This recipes serves as sample code to do this. 
  18.  
  19. Description
  20.  
  21. When an embedded part is selected, the active part should set the name of the “Info…” menu item to “Part Info…”, and selecting the command should bring up the PartFrameInfo dialog on that selected part.  When a link border is selected, the active part should set the name of the “Info…” menu item to “Link Info…”, and selecting the command should bring up the appropriate LinkInfo dialog.   If some native content is selected, and the active part supports an Info dialog of its own on that selected content, then it should set the name of the “Info…” menu item appropriately: “<mycontent> Info…” and display the appropriate dialog when the command is selected.  If there is no selection, the name of the “Info…” menu item should be set to “Part Info…” and the item disabled.
  22.  
  23. Changes since November, 1994
  24.  
  25. •  The recipe for handling the results of ShowLinkSourceInfo has changed slightly.  It is not necessary for the part to check for a change to the autoUpdate setting if infoAction.action is kODLinkInfoUpdateNow.  If the send updates setting is changed to automatic, the Update Now button is disabled.  If the send updates setting is changed to manual, the link should already be up to date.
  26.  
  27. Caveats
  28.  
  29. • This sample uses a private field fSelection which keeps track of the selection in a part specific manner.  For simplicity’s sake, we assume fSelection is an object which supports a few boolean methods regarding the nature of the selection.
  30.  
  31. • If the part editor does not support linking, then it can ignore the Link Info cases.
  32.  
  33. • If the part editor does support linking, the LinkBroken method notifies the selection that the content is no longer linked, the 
  34. UpdateSelectedLinks method causes source content to update a link and destination content to be replaced by the current link content, and the GetContentChangeID method returns the change id associated with the selected link content.
  35.  
  36. • If the part editor does not support embedding or linking, and does not support Info on any native content, then it should always set the menu item to "Part Info…" and disable it.
  37.  
  38. Sample
  39.  
  40. #ifndef SOM_ODInfo_xh
  41. #include <Info.xh>
  42. #endif
  43.  
  44. #ifndef SOM_ODSession_xh
  45. #include <ODSessn.xh>
  46. #endif
  47.  
  48. #ifndef SOM_ODArbitrator_xh
  49. #include <Arbitrat.xh>
  50. #endif
  51.  
  52. #ifndef SOM_ODMenuBar_xh
  53. #include <MenuBar.xh>
  54. #endif
  55.  
  56. #ifndef SOM_ODLink_xh
  57. #include <Link.xh>
  58. #endif
  59.  
  60. #ifndef SOM_ODLinkSource_xh
  61. #include <LinkSrc.xh>
  62. #endif
  63.  
  64.  
  65. …
  66.  
  67. SOM_Scope void  SOMLINK XYZCompany_XYZPartAdjustMenus(
  68.         XYZCompany_XYZPart *somSelf, Environment *ev,
  69.         ODFrame* frame)
  70.  
  71. {
  72.  
  73. …
  74.  
  75.     _fMenuBar->EnableCommand(ev, kODCommandGetPartInfo, kODTrue);
  76.  
  77. …
  78.  
  79. }
  80.  
  81. SOM_Scope void  SOMLINK XYZCompany_XYZPartDoInfoCommand(
  82.         XYZCompany_XYZPart *somSelf, Environment *ev)
  83.  
  84. {
  85.  
  86. // called probably from this part's HandleEvent method tç
  87.     if  (fSelection->EmbeddedFrameSelected())
  88.  
  89.     {
  90.  
  91.         ODInfo* info = somSelf->GetStorageUnit(ev)
  92.  
  93.                                 ->GetSession(ev)
  94.  
  95.                                 ->GetInfo(ev);
  96.  
  97.         info->ShowPartFrameInfo(ev, _fSelection->GetFirstSelectedFacet(), fPermissions>=kDPSharedWrite);
  98.  
  99.     }
  100.  
  101. // Skip this else clause if your part editor does not support linking
  102.  
  103.     else if (_fSelection->LinkSourceBorderSelected())
  104.  
  105.     {
  106.  
  107.         ODLinkInfoResult     infoResult;
  108.  
  109.         ODLinkSource* linkSource = _fSelection->GetSelectedLinkSource();
  110.  
  111.         if ( linkSource->ShowLinkSourceInfo(ev, 
  112.  
  113.                                         _fSelection->GetFirstSelectedFacet(),
  114.  
  115.                                         _fSelection->GetContentChangeID(), fPermissions>=kDPSharedWrite,  
  116.  
  117.                                         &infoResult))
  118.  
  119.         {
  120.  
  121.             switch (infoResult.action) 
  122.  
  123.             {
  124.  
  125.             case kODLinkInfoBreakLink:
  126.  
  127.                 linkSource->SetSourcePart(ev, kODNULL);
  128.  
  129.                 linkSource->Release(ev);
  130.  
  131.                 _fSelection->LinkBroken();
  132.  
  133.                 somSelf->GetStorageUnit(ev)->GetDraft(ev)
  134.                     ->SetChangedFromPrev(ev);
  135.  
  136.                 break;
  137.  
  138.             case kODLinkInfoUpdateNow:
  139.  
  140.                 _fSelection->UpdateSelectedLink();
  141.  
  142.                 break;
  143.  
  144.             case kODLinkInfoOk:
  145.  
  146.                 if (infoResult.autoUpdate != linkSource->IsAutoUpdate(ev))
  147.  
  148.                 {
  149.  
  150.                     linkSource->SetAutoUpdate(ev, infoResult.autoUpdate);
  151.  
  152.                     if (infoResult.autoUpdate && 
  153.  
  154.                           (_fSelection->GetContentChangeID() != 
  155.  
  156.                                 linkSource->GetChangeID(ev))
  157.  
  158.                        )
  159.  
  160.                         _fSelection->UpdateSelectedLink();
  161.  
  162.                 }
  163.  
  164.                 break;
  165.  
  166.             default:
  167.  
  168.                 break;
  169.  
  170.             }
  171.  
  172.         }
  173.  
  174.     }
  175.  
  176. // Skip this else clause if your part editor do not support linking
  177.  
  178.     else if (_fSelection->LinkDestBorderSelected())
  179.  
  180.     {
  181.  
  182.         ODLinkInfoResult infoResult;
  183.  
  184.         ODLink* linkDest = _fSelection->GetSelectedLinkDest();
  185.  
  186.         ODLinkInfo* linkInfo = _fSelection->GetSelectedLinkInfo();
  187.  
  188.  
  189.         if (linkDest->ShowLinkDestinationInfo(ev, 
  190.  
  191.                                         _fSelection->GetFirstSelectedFacet(),
  192.  
  193.                                         linkInfo, fPermissions>=kDPSharedWrite, 
  194.  
  195.                                         &infoResult))
  196.  
  197.         {
  198.  
  199.             if (infoResult.action != kODLinkInfoBreakLink) 
  200.  
  201.                 if (infoResult.autoUpdate != linkInfo->autoUpdate)
  202.  
  203.                 {
  204.  
  205.                     linkInfo->autoUpdate = infoResult.autoUpdate;
  206.  
  207.                     if (infoResult.autoUpdate)
  208.  
  209.                     {
  210.  
  211.                         linkDest->RegisterDependent(ev, 
  212.                                                         _fPartWrapper, 
  213.  
  214.                                                         linkInfo->change);
  215.  
  216.                     }
  217.  
  218.                 }
  219.  
  220.  
  221.  
  222.             switch (infoResult.action) 
  223.  
  224.             {
  225.  
  226.             case kODLinkInfoFindSource:
  227.  
  228.                 linkDest->ShowSourceContent(ev);
  229.  
  230.                 break;
  231.  
  232.             case kODLinkInfoBreakLink:
  233.  
  234.                 // Only unregister if there are no more destinations of
  235.  
  236.                 //   this link in this part.
  237.  
  238.                 linkDest->UnregisterDependent(ev, _fPartWrapper);
  239.  
  240.                 linkDest->Release(ev);
  241.  
  242.                 _fSelection->LinkBroken();
  243.  
  244.                 somSelf->GetStorageUnit(ev)->GetDraft(ev)->
  245.  
  246.                     SetChangedFromPrev(ev);
  247.  
  248.                 break;
  249.  
  250.             case kODLinkInfoUpdateNow:
  251.  
  252.                 _fSelection->UpdateSelectedLink();
  253.  
  254.                 break;
  255.  
  256.             default:
  257.  
  258.                 break;
  259.  
  260.             }
  261.  
  262.         }
  263.  
  264.     }
  265.  
  266. }
  267.  
  268.